OverlayDomain

class OverlayDomain : Domain

This domain provides various functionality related to drawing atop the inspected page.

This API is marked as experimental in protocol definition and can change in the future.

Functions

description

fun description(): String

Returns domain description.

disable

fun disable(): Single<RequestResponseFrame>

Disables domain notifications.

enable

fun enable(): Single<RequestResponseFrame>

Enables domain notifications.

events

fun events(): Flowable<Event>

Returns flowable capturing all domains events.

fun events(filter: Predicate<Event>): Flowable<Event>

Returns flowable capturing all domains events matching predicate.

fun <T : Event> events(eventClass: Class<T>): Flowable<T>

Returns flowable capturing all domain events of a given type.

fun <T : Event> events(eventClass: Class<T>, filter: Predicate<T>): Flowable<T>

Returns flowable capturing all domain events of a given type matching predicate.

getDependencies

open override fun getDependencies(): List<Domain>

Returns list of dependant domains that should be enabled prior to enabling this domain.

getGridHighlightObjectsForTest

fun getGridHighlightObjectsForTest(input: GetGridHighlightObjectsForTestRequest): Single<GetGridHighlightObjectsForTestResponse>

For Persistent Grid testing.

getHighlightObjectForTest

fun getHighlightObjectForTest(input: GetHighlightObjectForTestRequest): Single<GetHighlightObjectForTestResponse>

For testing.

getSourceOrderHighlightObjectForTest

fun getSourceOrderHighlightObjectForTest(input: GetSourceOrderHighlightObjectForTestRequest): Single<GetSourceOrderHighlightObjectForTestResponse>

For Source Order Viewer testing.

hideHighlight

fun hideHighlight(): Single<RequestResponseFrame>

Hides any highlight.

highlightFrame

fun highlightFrame(input: HighlightFrameRequest): Single<RequestResponseFrame>

Highlights owner element of the frame with given id.

highlightNode

fun highlightNode(input: HighlightNodeRequest): Single<RequestResponseFrame>

Highlights DOM node with given id or with the given JavaScript object wrapper.

highlightQuad

fun highlightQuad(input: HighlightQuadRequest): Single<RequestResponseFrame>

Highlights given quad.

highlightRect

fun highlightRect(input: HighlightRectRequest): Single<RequestResponseFrame>

Highlights given rectangle.

highlightSourceOrder

fun highlightSourceOrder(input: HighlightSourceOrderRequest): Single<RequestResponseFrame>

Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper.

inspectModeCanceled

fun inspectModeCanceled(): Flowable<RawEvent>

Fired when user cancels the inspect mode.

inspectNodeRequested

fun inspectNodeRequested(): Flowable<InspectNodeRequestedEvent>

Fired when the node should be inspected.

name

fun name(): String

Returns domain name.

nodeHighlightRequested

fun nodeHighlightRequested(): Flowable<NodeHighlightRequestedEvent>

Fired when the node should be highlighted.

screenshotRequested

fun screenshotRequested(): Flowable<ScreenshotRequestedEvent>

Fired when user asks to capture screenshot of some area on the page.

setInspectMode

fun setInspectMode(input: SetInspectModeRequest): Single<RequestResponseFrame>

Enters the 'inspect' mode.

setPausedInDebuggerMessage

fun setPausedInDebuggerMessage(input: SetPausedInDebuggerMessageRequest): Single<RequestResponseFrame>

setShowAdHighlights

fun setShowAdHighlights(input: SetShowAdHighlightsRequest): Single<RequestResponseFrame>

Highlights owner element of all frames detected to be ads.

setShowDebugBorders

fun setShowDebugBorders(input: SetShowDebugBordersRequest): Single<RequestResponseFrame>

Requests that backend shows debug borders on layers

setShowFlexOverlays

fun setShowFlexOverlays(input: SetShowFlexOverlaysRequest): Single<RequestResponseFrame>

setShowFPSCounter

fun setShowFPSCounter(input: SetShowFPSCounterRequest): Single<RequestResponseFrame>

Requests that backend shows the FPS counter

setShowGridOverlays

fun setShowGridOverlays(input: SetShowGridOverlaysRequest): Single<RequestResponseFrame>

Highlight multiple elements with the CSS Grid overlay.

setShowHinge

fun setShowHinge(input: SetShowHingeRequest): Single<RequestResponseFrame>

Add a dual screen device hinge

setShowHitTestBorders

fun setShowHitTestBorders(input: SetShowHitTestBordersRequest): Single<RequestResponseFrame>

Requests that backend shows hit-test borders on layers

setShowLayoutShiftRegions

fun setShowLayoutShiftRegions(input: SetShowLayoutShiftRegionsRequest): Single<RequestResponseFrame>

Requests that backend shows layout shift regions

setShowPaintRects

fun setShowPaintRects(input: SetShowPaintRectsRequest): Single<RequestResponseFrame>

Requests that backend shows paint rectangles

setShowScrollBottleneckRects

fun setShowScrollBottleneckRects(input: SetShowScrollBottleneckRectsRequest): Single<RequestResponseFrame>

Requests that backend shows scroll bottleneck rects

setShowViewportSizeOnResize

fun setShowViewportSizeOnResize(input: SetShowViewportSizeOnResizeRequest): Single<RequestResponseFrame>

Paints viewport size upon main frame resize.

setShowWebVitals

fun setShowWebVitals(input: SetShowWebVitalsRequest): Single<RequestResponseFrame>

Request that backend shows an overlay with web vital metrics.

Sources

jvm source